/*
 * yocef - Lightweight IoC Event Framework
 *
 * Copyright (c) 2009, Yves Cuillerdier
 * All rights reserved.
 * 
 * This software is licensed under the new BSD License:
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, 
 * this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice, 
 * this list of conditions and the following disclaimer in the documentation 
 * and/or other materials provided with the distribution.
 * 
 * Neither the name of the author nor the names of its contributors may 
 * be used to endorse or promote products derived from this software without 
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 * @version 1.1.0
 */
package yocef.client.trace;

import yocef.client.Event;

/**
 * "Trace Events" could be automatically fired for ALL events or specific ones.
 * <p>
 * It is possible to receive specific events when Events (native or custom) are
 * handled. This is controled by the {@link Event#setTraceAll(boolean)} or
 * {@link Event#setTrace(boolean)} methods. The first method set the tracing for
 * <b>ALL</b> events while the second set it only for the given Event.
 * <p>
 * When trace is enabled either for the Event <b>class</b> or for a given Event
 * <b>instance</b>, the Events defined in this enum are fired. The source for
 * these events are:
 * <ul>
 * <li><tt>Event.class</tt> for the global tracing</li>
 * <li><tt>Event.get(myEvent)</tt> for individual tracing</li>
 * </ul>
 * <p>
 * The two events have the following parameters;
 * <ul>
 * <li>trace: String giving informations on the event.</li>
 * <li>event: The event name.</li>
 * <li>source: The source Object.</li>
 * </ul>
 * These events could be capture for any purpose (for example logging).
 */
public enum EventEventTrace {

	/**
	 * Fire either by the Event <b>class</b> or <b>instance</b> before the true
	 * action is called.
	 */
	BeforeEventHandling,

	/**
	 * Fire either by the Event <b>class</b> or <b>instance</b> after the true
	 * action is called.
	 */
	EventHandled, ;

	/**
	 * Get the Event for this enum value
	 * 
	 * @return the Event for this enum value.
	 */
	public Event event() {
		return Event.get(name());
	}
}
